UnlockSession (Method)

Description

Unlocks the active session by logging out any concurrently active sessions for the shopper's Account. Introduced in v2.21.3.

Request (UnlockSessionSoapIn)

The request body is of type UnlockSession.

Example

Javascript

// Example: log out all other sessions for the current shopepr's account

MakeAJAXCall("Visitor.UnlockSession", {},console.log)

200 Response (UnlockSessionSoapOut)

The response body is of type UnlockSessionResponse.

Response Body Parameters

Name	Description	Data Type
UnlockSessionResult	// Example 1: Successful response { "Result": { "Success": true, "Message": "All other sessions have been logged out.", "ElapsedTime": "29 ms" } } // Example 2: No other active sessions { "Result": { "Success": false, "Message": "Unable to locate open Sessions.", "ElapsedTime": "4 ms" } } // Example 3: Error { "Result": { "Success": false, "Message": "An error occurred attempting to logout the other sessions.", "ElapsedTime": "4 ms" } }	xml:string

Name

Description

Data Type

UnlockSessionResult

// Example 1: Successful response

{
  "Result": {
    "Success": true,
    "Message": "All other sessions have been logged out.",
    "ElapsedTime": "29 ms"
  }
}

// Example 2: No other active sessions

{
  "Result": {
    "Success": false,
    "Message": "Unable to locate open Sessions.",
    "ElapsedTime": "4 ms"
  }
}

// Example 3: Error 

{
  "Result": {
    "Success": false,
    "Message": "An error occurred attempting to logout the other sessions.",
    "ElapsedTime": "4 ms"
  }
}

xml:string